32class AnimPar(Element):
33    """A container for SMIL Presentation Animations.
34
35    Arguments:
36
37        presentation_node_type -- default, on-click, with-previous,
38                                  after-previous, timing-root, main-sequence
39                                  and interactive-sequence
40
41        smil_begin -- indefinite, 10s, [id].click, [id].begin
42    """
43
44    _tag = "anim:par"
45    _properties = (
46        PropDef("presentation_node_type", "presentation:node-type"),
47        PropDef("smil_begin", "smil:begin"),
48    )
49
50    def __init__(
51        self,
52        presentation_node_type: str | None = None,
53        smil_begin: str | None = None,
54        **kwargs: Any,
55    ) -> None:
56        super().__init__(**kwargs)
57        if self._do_init:
58            if presentation_node_type:
59                self.presentation_node_type = presentation_node_type
60            if smil_begin:
61                self.smil_begin = smil_begin

67class AnimSeq(Element):
68    """TA container for SMIL Presentation Animations. Animations
69    inside this block are executed after the slide has executed its initial
70    transition.
71
72    Arguments:
73
74        presentation_node_type -- default, on-click, with-previous,
75                                  after-previous, timing-root, main-sequence
76                                  and interactive-sequence
77    """
78
79    _tag = "anim:seq"
80    _properties = (PropDef("presentation_node_type", "presentation:node-type"),)
81
82    def __init__(
83        self,
84        presentation_node_type: str | None = None,
85        **kwargs: Any,
86    ) -> None:
87        super().__init__(**kwargs)
88        if self._do_init and presentation_node_type:
89            self.presentation_node_type = presentation_node_type

 95class AnimTransFilter(Element):
 96    """
 97    Class to make a beautiful transition between two frames.
 98
 99    Arguments:
100      smil_dur -- XXX complete me
101
102      smil_type and smil_subtype -- see http://www.w3.org/TR/SMIL20/
103                    smil-transitions.html#TransitionEffects-Appendix
104                                    to get a list of all types/subtypes
105
106      smil_direction -- forward, reverse
107
108      smil_fadeColor -- forward, reverse
109
110      smil_mode -- in, out
111    """
112
113    _tag = "anim:transitionFilter"
114    _properties = (
115        PropDef("smil_dur", "smil:dur"),
116        PropDef("smil_type", "smil:type"),
117        PropDef("smil_subtype", "smil:subtype"),
118        PropDef("smil_direction", "smil:direction"),
119        PropDef("smil_fadeColor", "smil:fadeColor"),
120        PropDef("smil_mode", "smil:mode"),
121    )
122
123    def __init__(
124        self,
125        smil_dur: str | None = None,
126        smil_type: str | None = None,
127        smil_subtype: str | None = None,
128        smil_direction: str | None = None,
129        smil_fadeColor: str | None = None,
130        smil_mode: str | None = None,
131        **kwargs: Any,
132    ) -> None:
133        super().__init__(**kwargs)
134        if self._do_init:
135            if smil_dur:
136                self.smil_dur = smil_dur
137            if smil_type:
138                self.smil_type = smil_type
139            if smil_subtype:
140                self.smil_subtype = smil_subtype
141            if smil_direction:
142                self.smil_direction = smil_direction
143            if smil_fadeColor:
144                self.smil_fadeColor = smil_fadeColor
145            if smil_mode:
146                self.smil_mode = smil_mode

147class Annotation(Element):
148    """Annotation element credited to the given creator with the
149    given text, optionally dated (current date by default).
150    If name not provided and some parent is provided, the name is
151    autogenerated.
152
153    Arguments:
154
155        text -- str or odf_element
156
157        creator -- str
158
159        date -- datetime
160
161        name -- str
162
163        parent -- Element
164    """
165
166    _tag = "office:annotation"
167    _properties = (
168        PropDef("name", "office:name"),
169        PropDef("note_id", "text:id"),
170    )
171
172    def __init__(
173        self,
174        text_or_element: Element | str | None = None,
175        creator: str | None = None,
176        date: datetime | None = None,
177        name: str | None = None,
178        parent: Element | None = None,
179        **kwargs: Any,
180    ) -> None:
181        # fixme : use offset
182        # TODO allow paragraph and text styles
183        super().__init__(**kwargs)
184
185        if self._do_init:
186            self.note_body = text_or_element  # type:ignore
187            if creator:
188                self.dc_creator = creator
189            if date is None:
190                date = datetime.now()
191            self.dc_date = date
192            if not name:
193                name = get_unique_office_name(parent)
194                self.name = name
195
196    @property
197    def note_body(self) -> str:
198        return self.text_content
199
200    @note_body.setter
201    def note_body(self, text_or_element: Element | str | None) -> None:
202        if text_or_element is None:
203            self.text_content = ""
204        elif isinstance(text_or_element, str):
205            self.text_content = text_or_element
206        elif isinstance(text_or_element, Element):
207            self.clear()
208            self.append(text_or_element)
209        else:
210            raise TypeError(f'Unexpected type for body: "{type(text_or_element)}"')
211
212    @property
213    def start(self) -> Element:
214        """Return self."""
215        return self
216
217    @property
218    def end(self) -> Element | None:
219        """Return the corresponding annotation-end tag or None."""
220        name = self.name
221        parent = self.parent
222        if parent is None:
223            raise ValueError("Can't find end tag: no parent available")
224        body = self.document_body
225        if not body:
226            body = parent
227        return body.get_annotation_end(name=name)
228
229    def get_annotated(
230        self,
231        as_text: bool = False,
232        no_header: bool = True,
233        clean: bool = True,
234    ) -> Element | list | str | None:
235        """Returns the annotated content from an annotation.
236
237        If no content exists (single position annotation or annotation-end not
238        found), returns [] (or "" if text flag is True).
239        If as_text is True: returns the text content.
240        If clean is True: suppress unwanted tags (deletions marks, ...)
241        If no_header is True: existing text:h are changed in text:p
242        By default: returns a list of odf_element, cleaned and without headers.
243
244        Arguments:
245
246            as_text -- boolean
247
248            clean -- boolean
249
250            no_header -- boolean
251
252        Return: list or Element or text or None
253        """
254        end = self.end
255        if end is None:
256            if as_text:
257                return ""
258            return None
259        body = self.document_body
260        if not body:
261            body = self.root
262        return body.get_between(
263            self, end, as_text=as_text, no_header=no_header, clean=clean
264        )
265
266    def delete(self, child: Element | None = None, keep_tail: bool = True) -> None:
267        """Delete the given element from the XML tree. If no element is given,
268        "self" is deleted. The XML library may allow to continue to use an
269        element now "orphan" as long as you have a reference to it.
270
271        For Annotation : delete the annotation-end tag if exists.
272
273        Arguments:
274
275            child -- Element or None
276        """
277        if child is not None:  # act like normal delete
278            super().delete(child)
279            return
280        end = self.end
281        if end:
282            end.delete()
283        # act like normal delete
284        super().delete()
285
286    def check_validity(self) -> None:
287        if not self.note_body:
288            raise ValueError("Annotation must have a body")
289        if not self.dc_creator:
290            raise ValueError("Annotation must have a creator")
291        if not self.dc_date:
292            self.dc_date = datetime.now()

298class AnnotationEnd(Element):
299    """AnnotationEnd: the "office:annotation-end" element may be used to
300    define the end of a text range of document content that spans element
301    boundaries. In that case, an "office:annotation" element shall precede
302    the "office:annotation-end" element. Both elements shall have the same
303    value for their office:name attribute. The "office:annotation-end" element
304    shall be preceded by an "office:annotation" element that has the same
305    value for its office:name attribute as the "office:annotation-end"
306    element. An "office:annotation-end" element without a preceding
307    "office:annotation" element that has the same name assigned is ignored.
308    """
309
310    _tag = "office:annotation-end"
311    _properties = (PropDef("name", "office:name"),)
312
313    def __init__(
314        self,
315        annotation: Element | None = None,
316        name: str | None = None,
317        **kwargs: Any,
318    ) -> None:
319        """Initialize an AnnotationEnd element. Either annotation or name must be
320        provided to have proper reference for the annotation-end.
321
322        Arguments:
323
324            annotation -- odf_annotation element
325
326            name -- str
327        """
328        # fixme : use offset
329        # TODO allow paragraph and text styles
330        super().__init__(**kwargs)
331        if self._do_init:
332            if annotation:
333                name = annotation.name  # type: ignore
334            if not name:
335                raise ValueError("Annotation-end must have a name")
336            self.name = name
337
338    @property
339    def start(self) -> Element | None:
340        """Return the corresponding annotation starting tag or None."""
341        name = self.name
342        parent = self.parent
343        if parent is None:
344            raise ValueError("Can't find start tag: no parent available")
345        body = self.document_body
346        if not body:
347            body = parent
348        return body.get_annotation(name=name)
349
350    @property
351    def end(self) -> Element:
352        """Return self."""
353        return self

1054class BackgroundImage(Style, DrawImage):
1055    _tag = "style:background-image"
1056    _properties: tuple[PropDef, ...] = (
1057        PropDef("name", "style:name"),
1058        PropDef("display_name", "style:display-name"),
1059        PropDef("svg_font_family", "svg:font-family"),
1060        PropDef("font_family_generic", "style:font-family-generic"),
1061        PropDef("font_pitch", "style:font-pitch"),
1062        PropDef("position", "style:position", "background-image"),
1063        PropDef("repeat", "style:repeat", "background-image"),
1064        PropDef("opacity", "draw:opacity", "background-image"),
1065        PropDef("filter", "style:filter-name", "background-image"),
1066        PropDef("text_style", "text:style-name"),
1067    )
1068
1069    def __init__(
1070        self,
1071        name: str | None = None,
1072        display_name: str | None = None,
1073        position: str | None = None,
1074        repeat: str | None = None,
1075        opacity: str | None = None,
1076        filter: str | None = None,  # noqa: A002
1077        # Every other property
1078        **kwargs: Any,
1079    ):
1080        kwargs["family"] = "background-image"
1081        super().__init__(**kwargs)
1082        if self._do_init:
1083            kwargs.pop("tag", None)
1084            kwargs.pop("tag_or_elem", None)
1085            self.family = "background-image"
1086            if name:
1087                self.name = name
1088            if display_name:
1089                self.display_name = display_name
1090            if position:
1091                self.position = position
1092            if repeat:
1093                self.position = repeat
1094            if opacity:
1095                self.position = opacity
1096            if filter:
1097                self.position = filter
1098            # Every other properties
1099            for prop in BackgroundImage._properties:
1100                if prop.name in kwargs:
1101                    self.set_style_attribute(prop.attr, kwargs[prop.name])